Update help documentation to use consistent 'instance' terminology #239
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Update help documentation to use consistent 'instance' terminology
Summary
This PR updates help documentation and examples throughout the brev CLI to use consistent terminology: changing "workspace" references to "instance" and "my-app" examples to "my-instance" in user-facing help text, command descriptions, and documentation files.
Changes made:
pkg/cmd/open/open.go: Changed help strings from "workspace" to "instance" and examples from "my-app" to "my-instance"pkg/cmd/shell/shell.go: Changed help strings from "workspace" to "instance" and examples from "my-app" to "my-instance"pkg/cmd/create/doc.md,pkg/cmd/start/doc.md,pkg/cmd/status/doc.md): Updated examples to use consistent "instance" terminologyImpact: 5 files changed with 89 insertions and 89 deletions (clean text replacements). This is primarily a documentation update and should not affect CLI functionality.
Review & Testing Checklist for Human
brev open --helpandbrev shell --helpto verify the updated help text displays correctly with "instance" terminologybrev openandbrev shellcommands still work as expected (functionality should be unaffected)Test plan: Try running basic CLI help commands and a few actual commands to ensure the terminology updates are visible to users and don't break existing functionality.
Diagram
%%{ init : { "theme" : "default" }}%% graph TD OpenCmd["pkg/cmd/open/open.go<br/>openLong, openExample, Short"]:::major-edit ShellCmd["pkg/cmd/shell/shell.go<br/>openLong, openExample"]:::major-edit CreateDoc["pkg/cmd/create/doc.md<br/>Help examples"]:::minor-edit StartDoc["pkg/cmd/start/doc.md<br/>Help examples"]:::minor-edit StatusDoc["pkg/cmd/status/doc.md<br/>Help examples"]:::minor-edit CLI["brev CLI<br/>User Interface"]:::context CLI --> OpenCmd CLI --> ShellCmd OpenCmd -.-> CreateDoc ShellCmd -.-> StartDoc StatusDoc -.-> CLI subgraph Legend L1[Major Edit]:::major-edit L2[Minor Edit]:::minor-edit L3[Context/No Edit]:::context end classDef major-edit fill:#90EE90 classDef minor-edit fill:#ADD8E6 classDef context fill:#FFFFFFNotes
pkg/cmd/cmd.goalready correctly uses "brev client for managing instances" so no changes were needed thereSession details: